CWDIRECTCP_INSTALL

DRIVE

The drive where CWSerenade has been installed.

Note: Make sure you do not add an extra space after your entry. For example, if the drive is C:, make sure you do not enter a space after the colon (:).

CWDIRECTCP_UPLOAD_DIRECTORY

The location on the CWSerenade application server where files are uploaded to CWSerenade.

The delivered directory is /home/dev/server/Serenade/CWSerenade/File/Uploads. See Working with File Uploads (WUPL) for more information.

CWDIRECTCP_FTP_

FOLDER

The local directory on the CWSerenade application server where flat files are staged to transmit between the CWSerenade server and another server via FTP.

• If you are in a Windows environment, when entering the directory path, make sure you use a double backward slash between folder names. For example, if the directory path is C:\serenade\CWSerenade\FTP, enter C:\\serenade\\CWSerenade\\FTP.

• If you are in a Unix environment, when entering the directory path, make sure you use a double forward slash between folder names. For example, if the directory path is C:/serenade/CWSerenade/FTP, enter C://serenade//CWSerenade//FTP.

The delivered directory is C:\\serenade\\CWSerenade\\FTP, where C: is the root drive of the server.

Note: If this local directory does not already exist on the CWSerenade application server, the system dynamically creates it.

CWDIRECTCP_

REPORTS_DIRECTORY

The location on the CWSerenade application server where the system saves a copy of reports.

The delivered directory is C:\\serenade\\CWSerenade\\Forms, where C: is the root drive of the server.

Note: All backslashes in the directory path must be escaped (doubled \\).

If you are Using Multiple Application Servers

Configuration server or primary application server: This is a shared directory on the local drive.

Secondary application server: This is a mapped directory that points to the configuration server or primary application server’s drive. For example: \\\\APP1\\serenade\\CWSerenade\\Forms, where APP1 is the configuration server or primary application server’s name or IP address.

See Using Multiple CWSerenade Application Servers.

CWDIRECTCP_

DOCUMENTS_

DIRECTORY

The location on the CWSerenade application server where the system saves a copy of any documents (spool files).

The delivered directory is C:\\serenade\\CWSerenade\\Forms\\Documents, where C: is the root drive of the CWSerenade application server.

Note: All backslashes in the directory path must be escaped (doubled \\).

If you are Using Multiple Application Servers

Configuration server or primary application server: This is a shared directory on the local drive.

Secondary application server: This is a mapped directory that points to the configuration server or primary application server’s drive. For example: \\\\APP1\\serenade\\CWSerenade\\Forms\\Documents, where APP1 is the configuration server or primary application server’s name or IP address.

See Using Multiple CWSerenade Application Servers.

Application Server Settings

CWDIRECTCP_

APPLICATION_SERVER

Defines the application server used to run CWSerenade.

JBOSS defaults, indicating that CWSerenade runs on the JBOSS application server.

CWDIRECTCP_ALLOW_SCHEDULING_ON_THIS_SERVER

Defines whether a periodic process can be scheduled on this CWSerenade application server.

• Y = Periodic processes can be scheduled on this server. You must also define a unique name for the server in the CWDIRECTCP_SERVER_NAME setting.

• N = Periodic processes cannot be scheduled on this server. The system prevents you from creating a scheduled job on a server whose ALLOW_SCHEDULING_ON_THIS_SERVER setting is N.

Note: If you change this setting from N to Y, you can continue to the next step of scheduling a job on this server. If the job you wish to schedule on this server is already scheduled to run on a different server, you will need to delete the scheduled job and recreate it to run on this server. See Defining the Job Schedule.

To change this setting from Y to N:

1. Delete the scheduled jobs defined for the server.

2. Update the ALLOW_SCHEDULING_ON_THIS_SERVER setting for the server to N.

3. Restart the SERENADE service (or the application server) for the change to take effect.

4. Recreate the scheduled jobs on an application server whose ALLOW_SCHEDULING _ON_THIS_SERVER setting is set to Y.

For more information: See Scheduling Jobs.

CWDIRECTCP_SERVER_NAME

A unique name used to identify the server. This name displays in the Server field on the Scheduled Jobs Screen so that you can identify where the scheduled periodic process will run. This setting is a way to identify the server; it does not have to be the actual name or IP address of the server. The name you enter cannot be greater than 20 positions.

This setting is required if you set the ALLOW_SCHEDULING_ON_THIS_SERVER setting to Y for more than one application server.

Important: If you change this setting on a server that is associated with any scheduled jobs, you MUST delete the scheduled jobs that were defined for this server, change the server name, and then recreate the scheduled jobs.

If you enable scheduling on only one application server, you can leave this setting blank; however, the Server field on the Scheduled Jobs Screen will remain blank for each scheduled job.

For more information: See Scheduling Jobs.

Logging Settings

See Logs for more information on the logs available to help troubleshoot CWSerenade processing.

CW_LOG_DIR

The directory path on the CWSerenade application server where the logs are located.

The delivered directory is C:\\serenade\\CWSerenade\\Logs, where C: is the root drive of the server.

Note: All backslashes in the directory path must be escaped (doubled \\).

If you Use Multiple Application Servers

Primary application server: This is a directory on the local drive.

Secondary application server: This is a mapped directory that points to the primary application server’s drive. For example: \\\\APP1\\serenade\\CWSerenade\\Logs, where APP1 is the primary application server’s name or IP address.

See Using Multiple CWSerenade Application Servers.

MQ_FILE_NAME

The name of the log that stores XML and transactional message information.

The recommended setting is Message.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the Message log on each server to MSGSERVER1.log and MSGSERVER2.log.

APP_FILE_NAME

The name of the log that stores application information.

The delivered setting is APP.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the APP log on each server to APPSERVER1.log and APPSERVER2.log.

RESP_FILE_NAME

The name of the log that stores response information.

The delivered setting is RESP.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the RESP log on each server to RESPSERVER1.log and RESPSERVER2.log.

TRACE_FILE_NAME

The name of the log that stores trace information.

The delivered setting is TRACE.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the TRACE log on each server to TRACESERVER1.log and TRACESERVER2.log.

MANIFEST_FILE_NAME

The name of the log that stores manifesting information.

The delivered setting is MANIFEST.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the MANIFEST log on each server to MANIFESTSERVER1.log and MANIFESTSERVER2.log.

ORDER_FILE_NAME

The name of the log that stores order API information.

The delivered setting is ORDER.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the ORDER log on each server to ORDERSERVER1.log and ORDERSERVER2.log.

LOCATE_FILE_NAME

The name of the log that tracks Locate message activity.

The delivered setting is ORDER.log.

PAYPAL_FILE_NAME

The name of the log that stores PayPal transaction information.

The delivered setting is PAYPAL.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the PAYPAL log on each server to PAYPALSERVER1.log and PAYPALSERVER2.log.

UEP_FILE_NAME

The name of the log that stores user exit point activity information.

The delivered setting is USER_EXIT_POINT.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the user exit point log on each server to USER_EXIT_POINT1.log and USER_EXIT_POINT2.log.

CUST_FILE_NAME

The name of the log that stores Customer API transaction information.

The delivered setting is CUST.log.

If you Use Multiple Application Servers

If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the CUST log on each server to CUSTSERVER1.log and CUSTSERVER2.log.

ALERT_FILE_NAME

The name of the log that stores Job Monitor Alert information.

The delivered setting is ALERT.log.

INTEGRATIONORDER_ FILE_NAME

The name of the log that tracks activity related to the ChannelAdvisor integration.

The delivered setting is IntegrationOrder.log.

RELATE_FILE_NAME

The name of the log that tracks activity related to the Relate Loyalty integration.

The delivered setting is RELATE.log.

Additional Settings

CWDIRECTCP_USPS_ UPLOAD_FILE

The location on the CWSerenade application server where the system should look for the City State data file when you use the Load USPS Zip Code File (LZPS) to update postal code data.

The delivered directory is C:\\serenade\\CWSerenade\\LZIP\\ctystate.txt, where C: is the root drive of the server.

Note:

• All backslashes in the directory path must be escaped (doubled \\).

• MICROS recommends that you use a directory on your primary application server to load the ctystate.txt file.

If you are Using Multiple Application Servers

• If you are using multiple application servers, you need to update this setting on each server where you plan to use the Load USPS Zip Code File (LZPS) to update postal code data.

CWDIRECTCP_LR_RUN_JOB_MONITOR_ON_THIS_SERVER

Indicates whether the Long Running Jobs Monitor runs on this application server.

Valid values:

Y = The Long Running Jobs Monitor runs on this server.

N (default) or blank = The Long Running Jobs Monitor does not run on this server.

Note: If you are using a multiple application server environment, set this value to Y on one server only. Typically, you would set this to Y on the application server that runs batch jobs.

See Long Running Jobs Monitor for more information.

Cybersource Point-to-Point Integration Settings

See Cybersource Point-to-Point Integration for more information.

CYB_PAY_LINK_

SERVICE_KEY_

DIRECTORY

The location of the encrypted security key file used by the web service API program to validate and secure transactions from CWSerenade.

Note: When defining the location, use a single forward slash.

Example: C:/Cybersource/key/

CYB_PAY_LINK_

SERVICE_LOG_

DIRECTORY

The location of the log written by the web service API program. Use this log to review the transactions processed between CWSerenade and Cybersource.

Data security: For data security, CWSerenade masks credit card information in this log.

Note: When defining the location, use a single forward slash.

Example: C:/Cybersource/log/

Litle Point-to-Point Integration Settings

See Litle Point-to-Point Integration for more information.

LTD_PAY_LINK_

SERVICE_LOCAL_

SOURCE_DIRECTORY

The directory on the CWSerenade application server where request transactions are placed to send to Litle for processing. The directory entry must use a double forward slash. The recommended directory is C://CWSerenade//Integrations//Litle//Outbound//, where C is the root directory where CWSerenade is installed.

Note: If this directory does not already exist, the system creates it.

LTD_PAY_LINK_

SERVICE_LOCAL_

TARGET_DIRECTORY

The directory on the CWSerenade application server where response transactions are placed for CWSerenade to process. The directory entry must use a double forward slash. The recommended directory is C://CWSerenade//Integrations//Litle//Inbound//, where C is the root directory where CWSerenade is installed.

If this directory does not already exist, the system creates it.

ChannelAdvisor Integration Settings

See ChannelAdvisor Setup for more information.

CA_INVENTORY_FILE_LOCAL_FOLDER

The folder on the CWSerenade server where the CAINV periodic function writes the inventory file. See Sending Current Inventory Information to ChannelAdvisor for background.

Note: You should create this folder on your server if the folder does not already exist.

INTEGRATIONORDER_FILE_NAME

The name of the log that tracks activity related to the ChannelAdvisor integration.

The delivered setting is IntegrationOrder.log.

TLS Configuration Setting

See Configuring CWSerenade for TLS for more information.

GWT_RESOURCE_URI

When TLS communication is turned on, this property setting looks like the following:

https://localhost:8443/SerenadeSeam/srs

When TLS communication is turned off, this property setting looks like the following:

https://localhost:8080/SerenadeSeam/srs

Mass Customer Download Setting

See Mass Customer Download for more information.

MASS_CUSTDWNLD_

DOWNLOAD_

DIRECTORY

Required. The directory where CWSerenade places the Mass Customer Download file to be sent to an external system. This can be a directory on the CWSerenade application server or on another server. When you define the path, the backslashes in the directory path must be escaped (doubled \\). Example:

\\\\APP1\\CWSerenade\\Integrations\\Xlink

Note: If you define a directory on an external server, the remote destination folder must be a shared folder.

Job Monitoring Settings

See Monitoring Jobs for more information.

ALLOW_JOB_MONITOR_RULES_TO_RUN_ON_THIS_SERVER

Indicates whether job monitor rules run on this application server.

Valid values:

Y = The job monitor rules run on this server.

N (default) or blank = The job monitor rules do not run on this server. In this situation, the only option on the Work with Job Monitor Rules Screen is to display a rule’s settings.

Note: If you are using a multiple application server environment, set this value to Y on one server only that allows job scheduling; see Scheduling Jobs.

JOB_MONITOR_QUERY_DIRECTORY

The directory on the application server where you store queries used by the job monitor.

The delivered directory is C:\\CWSerenade\\JobMonitorQueries\\.

name

The name of the application without any version information included.

path

The location of the application folder on the server.

version

The version information of the product not including the patch level.

patch

The patch level of the application.